Fzzy Config/me.fzzyhmstrs.fzzy_config.validation.misc/ValidatedExpression

ValidatedExpression

open class ValidatedExpression @JvmOverloads constructor(defaultValue: String, validVars: Set<Char> = setOf(), validator: EntryValidator<String> = object: EntryValidator<String> { override fun validateEntry(input: String, type: EntryValidator.ValidationType): ValidationResult<String> { return Expression.tryTest(input, validVars).wrap(input) } override fun toString(): String { return "Dummy test with valid variable chars" } }) : ValidatedField<String> , Expression

A validated math expression

This ValidatedField is itself an expression, so you can call eval() or evalSafe() on it directly

Author

fzzyhmstrs

Since

0.2.0

Parameters

defaultValue

String - representation of the desired math expression, parsed to a cached Expression internally.

validVars

Set - represents the valid variable characters the user can utilize in their expression.

validator

EntryValidator, optional - validates entered math strings

Throws

IllegalStateException

if the provided defaultValue is not a parsable Expression.

Samples

import me.fzzyhmstrs.fzzy_config.util.AllowableIdentifiers
import me.fzzyhmstrs.fzzy_config.util.EnumTranslatable
import me.fzzyhmstrs.fzzy_config.util.FcText.lit
import me.fzzyhmstrs.fzzy_config.util.ValidationResult
import me.fzzyhmstrs.fzzy_config.validation.collection.ValidatedList
import me.fzzyhmstrs.fzzy_config.validation.minecraft.ValidatedIdentifier
import me.fzzyhmstrs.fzzy_config.validation.minecraft.ValidatedRegistryType
import me.fzzyhmstrs.fzzy_config.validation.minecraft.ValidatedTagKey
import me.fzzyhmstrs.fzzy_config.validation.misc.*
import me.fzzyhmstrs.fzzy_config.validation.misc.ValidatedColor.Companion.validatedColor
import me.fzzyhmstrs.fzzy_config.validation.number.ValidatedInt
import net.minecraft.item.Items
import net.minecraft.item.SwordItem
import net.minecraft.registry.Registries
import net.minecraft.registry.tag.ItemTags
import net.minecraft.util.Identifier
import java.awt.Color
import java.util.function.Function

fun main() { 
   //sampleStart 
   // example validated Expression; automatically parses and caches the Math Expression input in string form.
// The user can input any equation they like as long as it uses x, y, both, or neither expected variables passed in the set
val validatedExpression = ValidatedExpression("2.5 * x ^ 2 - 45 * y", setOf('x', 'y'))

fun evalExpressionExample() {
    val vars = mapOf('x' to 2.0, 'y' to 10.0) //prepared variable map with the current values of the expected vars
    val result = validatedExpression.eval(vars) // (= -440.0) straight eval() call. This can throw exceptions, so use with caution
    val resultSafe = validatedExpression.evalSafe(vars, -250.0) //when possible, use evalSafe with a fallback
}

//fields and sections have lang keys based on their "location" in the Config class graph.
//Lange key composition is as follows
//1. the namespace of the config id: (my_mod)
//2. the path of the config id: (my_mod.my_config)
//3. any parent ConfigSection field names as declared in-code: (my_mod.my_config.subSection)
//4. the setting field name as declared in-code: (my_mod.my_config.subSection.fieldName)
val fieldLang = """
{
    "_comment1": "the lang for an example 'fieldName' setting in a config inside section 'subSection'",
    "my_mod.my_config.subSection.fieldName": "Very Important Setting",
    "my_mod.my_config.subSection.fieldName.desc": "This very important setting is used in this very important way."
}
""" 
   //sampleEnd
}

Constructors

ValidatedExpression

constructor()

A validated math expression with default equation of "0"

@JvmOverloads

constructor(defaultValue: String, validVars: Set<Char> = setOf(), validator: EntryValidator<String> = object: EntryValidator<String> { override fun validateEntry(input: String, type: EntryValidator.ValidationType): ValidationResult<String> { return Expression.tryTest(input, validVars).wrap(input) } override fun toString(): String { return "Dummy test with valid variable chars" } })

Properties

translatableEntryKey

open override var translatableEntryKey: String

Functions

open override fun accept(input: String)

updates the wrapped value. NOTE: this method will push updates to an UpdateManager, if any. For in-game updating consider validateAndSet

addListener

open fun ~~addListener~~(listener: Consumer<ValidatedField<String>>)

Attaches a listener to this field. This listener will be called any time the field is written to ("set"). accept, validateAndSet, setAndUpdate and so on will all call the listener.

andThen

open fun andThen(p0: Consumer<in String>): Consumer<String>

codec

fun codec(): Codec<String>

Provides a Codec representing the value type of this validation, backed by the validators within as applicable

copyStoredValue

open fun copyStoredValue(): String

Copies the stored value and returns it.

copyValue

open override fun copyValue(input: String): String

Copies the provided input as deeply as possible. For immutables like numbers and booleans, this will simply return the input

description

open fun description(fallback: String? = null): MutableText

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.

descriptionKey

open override fun descriptionKey(): String

translation key of this Translatable's description. the "description" in-game, the descriptions Enchantment Descriptions adds to enchantment tooltips are a good example.

deserializedChanged

open fun deserializedChanged(old: Any?, new: Any?): Boolean

Specialized equals method for determining if a newly deserialized value is effectively equal to its old counterpart.

eval

open override fun ~~eval~~(vars: Map<Char, Double>): Double

Evaluates the math expression

evalSafe

open fun evalSafe(vars: Map<Char, Double>, fallback: Double): Double

Evaluates an expression with a fallback. Will fail to fallback instead of throwing. This call is recommended over the 'raw' eval call

flags

open override fun flags(): Byte

get

open override fun get(): String

supplies the wrapped value

getDefault

fun getDefault(): String

Provides this validations default value

getEntryKey

abstract fun getEntryKey(): String

hasDescription

open fun hasDescription(): Boolean

Whether this Translatable has a valid description

hasFlag

open override fun hasFlag(flag: EntryFlag.Flag): Boolean

hasPrefix

open fun hasPrefix(): Boolean

Whether this Translatable has a valid prefix

hasTranslation

open fun hasTranslation(): Boolean

Whether this Translatable has a valid translation

instanceEntry

open override fun instanceEntry(): ValidatedExpression

creates a deep copy of this ValidatedExpression return ValidatedExpression wrapping a deep copy of the currently stored expression, valid variable, and validation

listenToEntry

open override fun listenToEntry(listener: Consumer<Entry<String, *>>)

Attaches a listener to this field. This listener will be called any time the field is written to ("set"). accept, validateAndSet, setAndUpdate and so on will all call the listener.

map

fun <N> map(to: Function<String, out N>, from: Function<in N, String>): ValidatedField<N>

Maps this validation to a new convertible type. The default value will be applied from this delegates current storedValue

fun <N> map(defaultValue: N, to: Function<String, out N>, from: Function<in N, String>): ValidatedField<N>

fun <N> map(to: Function<String, out N>, from: Function<in N, String>, defaultValue: String): ValidatedField<N>

Maps this validation to a new convertible type.

pairWith

fun <B> pairWith(other: Entry<B, *>): ValidatedPair<String, B>

Pairs this validation with another validation into one ValidatedPair

prefix

open fun prefix(fallback: String? = null): MutableText

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.

prefixKey

open override fun prefixKey(): String

translation key of this Translatable's inline prefix text. Unlike descriptions, which are usually displayed in-tooltips, prefixes are displayed inline in the config screen itself

prepare

open fun prepare(scope: String, groups: LinkedList<String>, annotations: List<Annotation>, globalAnnotations: List<Annotation>)

Called in the prepare stage of screen building to perform any necessary pre-entry-creation tasks.

setEntryKey

abstract fun setEntryKey(key: String)

toCondition

open fun toCondition(condition: ValidatedField<Boolean>, fallback: Supplier<String>): ValidatedCondition<String>

Convert this field to a ValidatedCondition using the provided validation as a supplier. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied.

open fun toCondition(condition: ValidatedCondition.Condition, fallback: Supplier<String>): ValidatedCondition<String>

open fun toCondition(condition: Supplier<Boolean>, failMessage: Text, fallback: Supplier<String>): ValidatedCondition<String>

Convert this field to a ValidatedCondition. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied.

open fun toCondition(scope: String, failMessage: Text, fallback: Supplier<String>): ValidatedCondition<String>

Convert this field to a ValidatedCondition using the provided scope with a default boolean provider. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied. The provided scope must point to a valid boolean config scope otherwise the initial condition will never pass.

toList

fun toList(vararg elements: String): ValidatedList<String>

Wraps the provided values into a ValidatedList with this field as validation

fun toList(collection: Collection<String>): ValidatedList<String>

Wraps the provided collection into a ValidatedList with this field as validation

toSet

fun toSet(vararg elements: String): ValidatedSet<String>

Wraps the provided values into a ValidatedSet with this field as validation

fun toSet(collection: Collection<String>): ValidatedSet<String>

Wraps the provided collection into a ValidatedSet with this field as validation

translationKey

open override fun translationKey(): String

translation key of this Translatable. the "name" in-game

trySerialize

fun trySerialize(input: Any?, errorBuilder: MutableList<String>, flags: Byte): TomlElement?

trySet

open override fun trySet(input: Any?)

Attempts to set an arbitrary input into this Entry. Should fail soft if the input is incompatible

update

open fun update(updateMessage: Text)

validateAndSet

open fun validateAndSet(input: String): ValidationResult<String>

A setter method for the storedValue that first validates the value being set and then stores the post-validation result.

validateAndSetFlagged

open fun validateAndSetFlagged(input: String, vararg flag: EntryFlag.Flag): ValidationResult<String>

A setter method for the storedValue that first validates the value being set and then stores the post-validation result.

widgetAndTooltipEntry

open fun widgetAndTooltipEntry(choicePredicate: ChoiceValidator<String> = ChoiceValidator.any()): ClickableWidget

Builds a new ClickableWidget and applies a tooltip to it. This shouldn't need to be overridden in most cases